sc-docs 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+tmp
+.bundle
+bundle
+devbin

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/frameworks/sproutcore"]
+	path = docs/frameworks/sproutcore
+  url = git://github.com/sproutcore/sproutcore.git

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem "sproutcore", "1.6.0.rc.1"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    sc-docs (0.0.1)
+      rack
+      thor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    chunky_png (1.1.2)
+    compass (0.11.1)
+      chunky_png (~> 1.1)
+      fssm (>= 0.2.7)
+      sass (~> 3.1)
+    daemons (1.1.3)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    eventmachine (0.12.10)
+    extlib (0.9.15)
+    fssm (0.2.7)
+    haml (3.1.1)
+    json_pure (1.4.6)
+    rack (1.2.2)
+    sass (3.1.1)
+    sproutcore (1.6.0.rc.1)
+      chunky_png (~> 1.1.0)
+      compass (~> 0.11.1)
+      erubis (~> 2.6.6)
+      extlib (~> 0.9.15)
+      haml (~> 3.1.1)
+      json_pure (~> 1.4.6)
+      rack (~> 1.2.1)
+      thin (~> 1.2.11)
+      thor (~> 0.14.3)
+    thin (1.2.11)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  sc-docs!
+  sproutcore (= 1.6.0.rc.1)

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (C) 2011 Apple Inc.
+Portions Copyright (C) 2011 Strobe Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,59 @@
+SproutCore Documentation Generator
+==================================
+
+A tool to generate documentation for the SproutCore framework and SproutCore projects, using the JSDoc format.
+
+**Authors**: Majd Taby, Peter Wagenet
+
+Usage
+-----
+
+### Basic
+
+    sc-docs --input_dir INPUT_DIRECTORY_PATH
+
+This documents the specified directory and then runs a preview sc-server instance.
+
+### Deploy
+
+    sc-docs --input_dir INPUT_DIRECTORY_PATH --deploy --project PROJECT_NAME \
+        --output_dir = OUTPUT_DIRECTORY_PATH
+
+The deploy flag runs sc-build and deploys to the specified directory. If no output_dir is specified then it is deployed to `/Library/WebServer/Documents/`.
+
+### HTML Templates
+
+    sc-docs --input_dir INPUT_DIRECTORY_PATH --template TEMPLATE_PATH --html
+
+By default sc-docs assumes that you want to generate docs for the SproutCore based Doc Viewer. However, you can also generate standard HTML templates.
+
+Dependencies
+------------
+
+### Gems
+
+* thor
+* child_labor
+* rack
+* thin *(optional, but recommended)*
+
+### Other
+
+* **node.js**: We use a special (much faster) version of jsdoc-toolkit that requires node.js.
+
+Templates
+---------
+
+### sc_fixture
+
+Generates the docs in JSON format for use within an SC based viewer app.
+
+### docs.sproutcore.com
+
+The template used at docs.sproutcore.com. Designed by Matt Grantham and Ryan Mudryk with additional work by Avrohom Katz.
+
+Credits
+------
+
+**jsdoc-toolkit**: Used for the heavy lifting of docs generation
+

data/bin/sc-docs

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'sc_docs/cli'
+
+ScDocs::CLI.start

data/lib/sc_docs.rb

@@ -0,0 +1,3 @@
+module ScDocs
+
+end

data/lib/sc_docs/cli.rb

@@ -0,0 +1,54 @@
+require 'thor'
+
+require 'sc_docs/generator'
+
+module ScDocs
+  class CLI < Thor
+
+    class_option :input_dir,  :aliases => ['-i'], :type => :string,
+      :banner => "Directory to generate docs for"
+    class_option :output_dir, :aliases => ['-o'], :type => :string,
+      :banner => "Directory to output docs to"
+    class_option :update,     :aliases => ['-u'], :type => :boolean, :default => false,
+      :banner => "If input is a git repo, pull and rebase"
+    class_option :template,   :aliases => ['-t'], :type => :string,
+      :banner => "Path to jsdoc template (forces HTML output)"
+    class_option :verbose,    :aliases => ['-v'], :type => :boolean, :default => false
+
+    desc "generate", "Generate docs"
+    method_option :project, :aliases => ['-p'], :type => :string,
+      :banner => "SproutCore Project Name"
+    def generate
+      puts "Generating Documentation...\n\n"
+      run_generator
+    end
+
+    desc "preview", "Preview docs output"
+    def preview
+      puts "Building Documentation Preview...\n\n"
+      run_generator(true)
+    end
+
+    private
+
+      def run_generator(preview=false)
+        update_repo if options[:update]
+
+        puts options[:template]
+        generator = (options[:template] ? HtmlGenerator : ScGenerator).new(options)
+        preview ? generator.preview : generator.generate
+      end
+
+      def update_repo
+        puts "Updating repository...\n\n" if options[:verbose]
+        
+        if File.directory? input_dir and File.directory? "#{input_dir}/.git"
+          Dir.chdir input_dir do
+            run("git fetch", print_output)
+            run("git rebase origin master", print_output)
+          end
+        end
+      end
+
+  end
+end

data/lib/sc_docs/docs/Buildfile

@@ -0,0 +1,8 @@
+# ==========================================================================
+# Project:   SproutCore - JavaScript Application Framework
+# Copyright: ©2008-2011 Apple Inc. All rights reserved.
+# License:   Licensed under MIT license (see license.js)
+# ==========================================================================
+
+
+config :all, :required => :sproutcore, :url_prefix => "sc_docs", :load_fixtures => true

data/lib/sc_docs/docs/README

@@ -0,0 +1,8 @@
+==========================================================================
+Project:   SproutCore - JavaScript Application Framework
+Copyright: ©2008-2011 Apple Inc. All rights reserved.
+License:   Licensed under MIT license (see license.js)
+==========================================================================
+
+TODO: Describe Your Project
+

data/lib/sc_docs/docs/apps/docs/Buildfile

@@ -0,0 +1,15 @@
+# ==========================================================================
+# Project:   SproutCore - JavaScript Application Framework
+# Copyright: ©2008-2011 Apple Inc. All rights reserved.
+# License:   Licensed under MIT license (see license.js)
+# ==========================================================================
+
+# This is your Buildfile for your app, Docs. This tells SproutCore
+# how to build your app. These settings override those in your project
+# Buildfile, which contains default settings for all apps in your project.
+#
+# This line tells SproutCore's CSS preprocessor what class names to target.
+# Since your app has a theme named 'docs', and it is based on SproutCore's
+# Ace theme (named 'ace'), it is set to 'ace.docs'.
+config :docs, :css_theme => 'ace.docs'
+

data/lib/sc_docs/docs/apps/docs/controllers/classes.js

@@ -0,0 +1,27 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+/*globals Docs */
+
+/** @class
+
+  (Document Your Controller Here)
+
+  @extends SC.TreeController
+*/
+Docs.classesController = SC.ArrayController.create(
+/** @scope Docs.classesController.prototype */ {
+
+  _selectionDidChange: function(){
+
+    var content = this.getPath('selection.firstObject');
+
+    if(content) {
+      SC.routes.set('location',content.get('displayName'));
+    }
+
+  }.observes('selection')
+
+}) ;

data/lib/sc_docs/docs/apps/docs/controllers/search_controller.js

@@ -0,0 +1,62 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+/*globals SC*/
+
+/** @class
+
+  Manages the search feature
+
+  @author Majd Taby
+  @extends SC.Object
+  @since SproutCore 1.5
+*/
+Docs.searchController = SC.Object.create({
+  searchQuery: '',
+
+  runQuery: function(sender){
+    this._runSearch(sender.get('value'));
+  },
+
+  queryDidChange: function(){
+    var query = this.get('searchQuery');
+    if (!query) {
+      this._clearSearch();
+    }
+
+    this._runSearch(query);
+
+  }.observes('searchQuery'),
+
+  _clearSearch: function(){
+      Docs.classesController.set('content',Docs.allClassesRecordArray);
+  },
+
+  _runSearch: function(query){
+
+    var matches = this._findMatchesForQuery(query);
+
+    if (matches) {
+      Docs.classesController.set('content',matches);
+    }
+  },
+
+  _findMatchesForQuery: function(query) {
+    var indexHash = Docs.get('indexHash');
+    var classMatches = [];
+    var symbolMatches = null;
+
+    // Go through every symbol, try to match the name of the class first
+    for(var name in indexHash){
+
+      if (name.indexOf(query) !== -1) {
+        var storeObject = Docs.store.materializeRecord(indexHash[name]);
+        classMatches.push(storeObject);
+      }
+    };
+
+    return classMatches;
+  }
+});

data/lib/sc_docs/docs/apps/docs/controllers/selected_class.js

@@ -0,0 +1,143 @@
+// ==========================================================================
+// Project:   SproutCore - JavaScript Application Framework
+// Copyright: ©2008-2011 Apple Inc. All rights reserved.
+// License:   Licensed under MIT license (see license.js)
+// ==========================================================================
+/*globals Docs */
+
+sc_require('system/jquery_ui');
+
+/** @class
+
+  (Document Your Controller Here)
+
+  @extends SC.ObjectController
+*/
+Docs.selectedClassController = SC.ObjectController.create(
+/** @scope Docs.selectedClassController.prototype */ {
+
+  contentBinding: SC.Binding.single('Docs.classesController.selection'),
+  nameBinding: SC.Binding.oneWay('.content.displayName'),
+
+  symbolSelection: null,
+  symbols: [],
+  properties: [],
+  methods: [],
+ 
+  _contentDidChange: function(){
+    var content = this.get('content');
+    if (!content) {return;}
+
+    var that = this;
+    // Give the browser a chance to render, we can wait
+    // for the next run loop
+    //that.invokeLater(function(){
+
+      var methods = content.get('methods').toArray().sortProperty('name');
+      var properties = content.get('properties').toArray().sortProperty('name');
+
+        that.set('symbols',properties.concat(methods));
+
+        that.set('properties',properties);
+        that.set('methods',methods);
+
+      that.invokeLater(function(){
+        that._updateDataTypeButtons();
+      });
+    //});
+      
+
+  }.observes('content'),
+
+  _updateLocation: function(symbol) {
+
+    var location = SC.routes.get('location');
+    var prefix = "/";
+    if(location) {
+      prefix = location.split('/')[0]+'/';
+    }
+    SC.routes.set('location',prefix+symbol.get('name'));
+
+  },
+
+  _scrollToSymbol: function($symbol){
+    var container = SC.$('.class-detail');
+    var position = this._positionInContainer($symbol[0],container[0]);
+
+    container.stop();
+    container.animate({scrollTop: position.top}, 250,'swing');
+    $symbol.children('.header').effect("highlight", {}, 1000);
+  },
+
+  _selectionDidChange: function(){
+    var symbol = this.getPath('symbolSelection.firstObject');
+    if (!symbol) { return; }
+
+    var that = this;
+    this.invokeLater(function(){
+      that._updateLocation(symbol);
+      
+      var $symbol = SC.$('div[name="'+symbol.get('name')+'"]');
+      if(!$symbol || !$symbol[0]) { return; }
+
+      that._scrollToSymbol($symbol);
+    });
+
+  }.observes('symbolSelection'),
+
+  _positionInContainer: function(obj,container) {
+    var curtop = 0;
+    var curleft = 0;
+
+    if (obj.offsetParent) {
+      do {
+        if (obj === container) { break; }
+
+        curleft += obj.offsetLeft;
+        curtop += obj.offsetTop;
+      } while (obj = obj.offsetParent);
+    }
+
+    return {left: curleft, top: curtop};
+  },
+
+  _updateDataTypeButtons: function() {
+
+    var that = this;
+    var dataTypes = SC.$('.class-detail .data-type');
+    var curClassName = that.getPath('content.displayName');
+    var symbols = this.get('symbols');
+
+    dataTypes.each(function(index){
+
+      var name = $(this).attr('name');
+      var indexHash = Docs.get('indexHash');
+      var valid = NO;
+
+      // Check if it's a top-level symbol
+      if (indexHash[name] && curClassName !== name) {
+        valid = YES;
+      }
+      // Assume it's a symbol in the current class
+      else if (symbols.findProperty('displayName',name)) {
+        valid = YES;
+      }
+
+      if (valid) {
+        var el = $(this);
+        el.addClass('clickable');
+
+        el.click(function(){
+          var name = el.attr('name');
+
+          if (name.indexOf('.') !== 0) {
+            Docs.routeToClass({'class': name});
+          }
+          else {
+            Docs.routeToSymbol({symbol: name});
+          }
+        });
+      }
+    });
+  }
+}) ;